Revises and clarifies contributing workflow
This commit is contained in:
committed by
Simon Michael
parent
f67f686317
commit
201c4737d9
45
README.md
45
README.md
@@ -1,35 +1,20 @@
|
||||
The plaintextaccounting.org website.
|
||||
An informative portal for Ledger, hledger, beancount, and the other ledger-likes.
|
||||
# The plaintextaccounting.org website.
|
||||
|
||||
The repo is named plaintextaccounting.github.io to make it the Github
|
||||
Pages site for the plaintextaccounting organization, so that it can be
|
||||
served with a custom domain.
|
||||
plaintextaccounting.org is an informative portal for Ledger, hledger, beancount, and the other ledger-likes.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
The repo is named `plaintextaccounting.github.io` to make it the Github
|
||||
Pages site for the
|
||||
[plaintextaccounting organization](https://github.com/plaintextaccounting/),
|
||||
so that it can be served with a custom domain, `plaintextaccounting.org`.
|
||||
|
||||
Fork the github repo, submit a pull request.
|
||||
If you're a recurring contributor, remind me to give you commit access.
|
||||
## Contributing Quick-start
|
||||
|
||||
Before committing, rebuild the HTML (requires pandoc):
|
||||
_For full instructions on contributing, see
|
||||
[CONTRIBUTING.md](CONTRIBUTING.md)._
|
||||
|
||||
$ make
|
||||
|
||||
and include it in your commit.
|
||||
|
||||
To rebuild on each file change (requires fswatch):
|
||||
|
||||
$ make watch
|
||||
|
||||
To rebuild and reload the browser page on file change,
|
||||
|
||||
Method 1 (requires livereloadx):
|
||||
|
||||
$ make watch
|
||||
in another window:
|
||||
$ npm install -g livereloadx
|
||||
$ make livereload
|
||||
visit http://localhost:35729
|
||||
|
||||
Method 2 (requires LiveReload):
|
||||
add the site folder in the LiveReload GUI, configure custom command "make", ?
|
||||
1. Fork this repository.
|
||||
2. Make changes to the `md` files, `css`, etc. **Don't change the `html` files.**
|
||||
3. Run `make` to regenerate the `html` files.
|
||||
4. Commit.
|
||||
5. Push to a branch on your fork.
|
||||
6. Submit a pull request.
|
||||
|
||||
Reference in New Issue
Block a user