usability updates to readme

RadicalxChange / rxc-voice

An app for decentralized democratic governance.

https://voice.radicalxchange.org/

Other

42 stars 14 forks source link

usability updates to readme #34

Closed whatSocks closed 3 years ago

whatSocks commented 3 years ago

added .env-example file so users wouldn't have to copy from readme to get started
added cd rxc-voice to setup instructions so users would be in the correct directory
added some formatting
added example docker command so new users could copy+paste to see if things are working
deleted .DS_Store

alexrandaccio commented 3 years ago

made small tweaks to your additions to the README @whatSocks, just for clarity. Thanks for your input! I haven't had much time to focus on documentation yet, so your contributions are much appreciated.

whatSocks commented 3 years ago

@alexrandaccio I don't have merge rights to this repo ;)

whatSocks commented 3 years ago

another change that would be good to make (here or separately) would be to not version control rxc-voice/src/utils/urls.ts but have another example file so when the developer changes it it doesn't mess up the version control

alexrandaccio commented 3 years ago

@alexrandaccio I don't have merge rights to this repo ;)

my bad, I'll merge it myself

another change that would be good to make (here or separately) would be to not version control rxc-voice/src/utils/urls.ts but have another example file so when the developer changes it it doesn't mess up the version control

totally agree, this is something I've been putting off doing for a while