gnolang / gnolang/getting-started

META Make this the easiest way to try Gno

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Gno
Stars
3
Forks
3
Avg merge
30m
Merged PRs (30d)
1

Description

This repository aims to help anyone try Gno in under five minutes.

We want it to be super minimal. It should contain just one small .gno file with Render and Set functions, along with comments or instructions in the Render section to explain how to use gnokey. There should be no publishing or extra folders; just the basics.

The README should clearly explain:

  • How to install it (git clone; make install). The make install command should check if Go is installed; if not, it should provide a link to instructions on how to install Go.
  • How to run gnodev (make dev). The make dev command should not install and call a binary but instead run go run github.com/..., so we don't have to worry about the $PATH. In the future, we can expect to install precompiled binaries without needing to install Go.
  • How to open the browser and try live editing at (https://localhost:8888).
  • Where to continue (https://docs.gno.land, https://github.com/gnolang/by-examples, https://github.com/gnolang/repo-template)

The Makefile should also be very simple; just enough to run locally and test (make dev, make test). There should be no advanced setup or CI beyond perhaps one simple test action.

In the future, we can link to a more advanced repository like template-gno-project. Here, we prioritize simplicity while utilizing as many good tools as possible, including advanced tests, several p/r actions, CI, etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the repository layout, README, and Makefile against the requested minimal structure: one small .gno file with Render and Set, simple install, dev, and test targets, and no extra folders. Done means the README covers installation, local development, browser access, and continuation links, while the Makefile supports the stated commands without advanced setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system, devtools, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.