Giter Site home page Giter Site logo

Create friendlier README.md about docker-zulip HOT 4 CLOSED

zulip avatar zulip commented on July 17, 2024
Create friendlier README.md

from docker-zulip.

Comments (4)

galexrt avatar galexrt commented on July 17, 2024

@cmcneil do you have any ideas on how to make the README.md look better?

from docker-zulip.

cmcneil avatar cmcneil commented on July 17, 2024

Startup from scratch: link to wiki. And then on the wiki, I agree with you that explanations of all the environmental vars would be good.

You could also just put the contents of the wiki page front and center in the Readme. I think I definitely expect github Readmes to tell you how to get it running from scratch. (i.e. "You need docker at least vX, and docker-compose at least vX. Then run these commands")

After I get this actually running, I'd be happy to write it up :p.

from docker-zulip.

galexrt avatar galexrt commented on July 17, 2024

@cmcneil Thanks for tipp! I'll try my best. :)

from docker-zulip.

galexrt avatar galexrt commented on July 17, 2024

I added a new README.md and added some more wiki pages with better explanations. I'm working on some more wiki pages about the setup process.

@cmcneil Could you maybe give me some feedback about the new wiki pages and the new README.md?

from docker-zulip.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.