Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md needs updating #73

Open
Finchiedev opened this issue Nov 7, 2019 · 2 comments
Open

README.md needs updating #73

Finchiedev opened this issue Nov 7, 2019 · 2 comments
Assignees
@Finchiedev
Labels
docs This is to do with the documentation or guide low-priority To Do Something that needs to be worked on

Comments

@Finchiedev
Copy link
Member

The following changes need to be made to README.md:

  • Add install instructions from Bintray, GitHub releases, Software Centre (CCGS only)
  • Decrease length of installation instructions, they don't need to be that long
  • Update developing guide with full process from download to development environment
  • Update feature list to reflect current status
@Finchiedev Finchiedev added To Do Something that needs to be worked on docs This is to do with the documentation or guide low-priority labels Nov 7, 2019
@Finchiedev Finchiedev self-assigned this Nov 7, 2019
@Finchiedev
Copy link
Member Author

For the development section:

  • How to create a release using release-it
  • How to start Electron
  • How to build for a specific target
  • How to use yarn

@Finchiedev
Copy link
Member Author

We should also link:

  • All the new GitBook documentation
  • The Riot/Gitter chat for non-CCGS discussion & help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Finchiedev Finchiedev

Labels
docs This is to do with the documentation or guide low-priority To Do Something that needs to be worked on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Finchiedev