X-Git-Url: https://jfr.im/git/irc/freenode/web-7.0.git/blobdiff_plain/86588cc83e69da5f839e50e5bf2d87594908930c..451d7720c831e134f2e860ddfe1138d1e92340ef:/README.md diff --git a/README.md b/README.md index aee696aad..994e53072 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# web-7.0 [![Build Status](https://travis-ci.org/freenode/web-7.0.svg?branch=master)](https://travis-ci.org/freenode/web-7.0) +# web-7.0 [![Build Status](https://travis-ci.org/freenode/web-7.0.svg?branch=main)](https://travis-ci.org/freenode/web-7.0) [![irc: #freenode-website](https://img.shields.io/badge/irc-%23freenode--website-brightgreen.svg)](https://webchat.freenode.net/?channels=freenode-website) A shiny replacement for http://freenode.net. @@ -8,7 +8,8 @@ A shiny replacement for http://freenode.net. You'll need our node.js dependencies: ```console -$ sudo npm install -g myth svgo +$ sudo npm install -g postcss-cli@7.1.2 svgo uglifyjs +$ npm install ``` Then, assuming a Python 3.4 (or later) installation: @@ -32,18 +33,20 @@ from any directory, you can also use `cms7 -c /path/to/config.yml`. - Whenever possible, one commit per feature. - If feature/pull-request branches have only one developer, please regularly - rebase them onto master until they are merged in. + rebase them onto main until they are merged in. - Don't merge branches with meaningless commit messages; always squash them instead. - Wait for discussion of big changes. Your branches will still be here tomorrow. +Please comply with the [contribution guidelines](CONTRIBUTING.md) + Helpful tip for those merging PRs: you can browse the tree a merge would result in by navigating to `https://github.com/freenode/web-7.0/tree/pull/XYZ/merge`, where `XYZ` is the pull request number. -You can also go to `https://freenode.github.io/web-7.0/BRANCHNAME/` to see a +You can also go to `https://freenode.net/web-7.0/BRANCHNAME/` to see a build of any particular branch. This also works for *internal* pull requests (they are named `pull-X`). @@ -83,6 +86,7 @@ Blog-specific: - `author` - `date` +- `enclosure` sets the podcast URL of an article ### Internal linking @@ -113,16 +117,3 @@ To do the same from a template, call `url_for`: ```html+jinja A page about frogs ``` - - -## TODO -- [ ] Get the basic static page up, and how to connect (latest two news about - the reformation + about page, kinda) scheduled release: 2016-02-29 - - [x] Design ready enough - - [x] Preprocessor ready - - [x] Templates ready enough - - [x] Content ready -- [x] KB pages structure, start adding KB's (note: tagging could be a good thing for searching and finding) -- [ ] Add possibility to edit on-site integrated with services (log in with your nickserv acc) -- [ ] Gms integration -- [ ] Further development TODO: TODO