Comments (2)
Description
How about moving the installation instructions from
README.md
into a file likeINSTALL.md
?This would allow
README.md
to be much more concise -- a project description, table of contents, and highly relevant links (Discord, etc.)
Hi @veganaize I don't think that it is needed at this point of time
from defaang.
The current README.md
weighs in at 90 LOC (lines of code) which doesn't strike me as too large at all. In fact, many repos have massive readmes that include everything about a library (take zod's 2224 line beast for example). Granted, the well structured table of contents definitely helps out.
I'll be honest, I'm not even sure it's necessary at this point (I might wait until >200 LOC), but one alternate resolution for this ticket could be an addition of a well-linked Table of Contents to README.md
, which would perhaps make it more navigable for newcomers.
from defaang.
Related Issues (20)
- [FEATURE] How it Works Section to be a Responsive card HOT 2
- [BUG] Figure out a better way to redirect from the question submission page HOT 14
- [FEATURE] Hover effect for how it works HOT 1
- [FEATURE] Make the header fixed for easy navigation HOT 1
- [CONTENT] Solve this problem and write out a solution for it. (or make a video) HOT 23
- [FEATURE] Embedding an online compiler/IDE into defaang for question submissions HOT 8
- [FEATURE] Add your coding platform profile while submitting question HOT 4
- [DOCS] Add a link to the sponsors page HOT 2
- [DX] Go through the issues & PRs HOT 4
- [FEATURE] Adding a "sign in" besides "sign up today" HOT 3
- [DX] Research on Firebase features HOT 3
- Adding an Owl Carousel to How it Works section HOT 1
- [DX] Copy over the project board to this new org. HOT 9
- [FEATURE] Enable Google OAuth 2.0 HOT 1
- [FEATURE] Design for View Questions [How it works] HOT 2
- [DOCS] Update the project board link in CONTRIBUTING.md HOT 5
- [PRODUCTION] Number of approved questions is not being reflected in the site HOT 1
- [DX] Look into Railway as a potential DB & backend solution HOT 3
- [FEATURE] Sticky Navbar HOT 1
- [BUG] Signup not working
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from defaang.