specter/gmi-web
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

contributing guide

Browse source
This commit is contained in:
Talon Poole 2021-02-19 20:40:24 +00:00
parent d11e241131
commit 7b2bfe327a
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,15 @@
There are currently three core components to gmi-web.
* `core.css` and `gmi.css` stylesheets
* `html.js` gmi-to-html implementation
* gmi-web(1) as defined by `cli.js`
The stylesheets are simple enough to modify. The latter two may compel you to clone this repo and make changes you'd like to test locally. You will need [node(1)](https://nodejs.org/en/) and [scdoc(1)](https://git.sr.ht/~sircmpwn/scdoc) to run `cli.js` and build the `gmi-web.1.scd` man page. `npm link` will install gmi-web(1) from the source allowing you to make modifications locally and test them immediately.
```
git clone https://codeberg.org/talon/gmi-web.git
cd gmi-web
npm link
```
Patches and issues can be submitted to code@talon.computer or expressed through the channels available on [Codeberg](https://codeberg.org/talon/gmi-web).