You are browsing as a guest. Sign up (or log in) to start making projects!

52m 24s logged

Devlog 9 – Writing the README πŸ“–

Today I finished the README.md file for my TaskForge project.

I added information about what TaskForge is, the main features, the project folder structure, the technologies I used, and how the project works. I also wrote about what I learned while making it and some problems I faced during development.

I wanted the README to be simple and easy to understand instead of making it look too professional.

What I worked on

  • Added the project introduction
  • Added the main features
  • Explained the folder and file structure
  • Added the technologies used
  • Added how I made the project
  • Added what I learned
  • Added testing information
  • Added problems I faced
  • Added some future improvement ideas
  • Added my final thoughts

What I learned

While writing the README, I learned that documentation is useful because it helps other people understand a project without looking through every file.

I also learned how Markdown headings, lists, code formatting, and sections can be used to organize a project README.

Testing

I checked the README on GitHub to make sure the headings, lists, and code formatting looked correct.

Project progress

This completes the final planned file of TaskForge.

TaskForge: 9/9 files completed πŸŽ‰

I now have a complete study planner with task management, a study timer, dashboard statistics, saved tasks using localStorage, and a subjects data file.

Made while learning web development πŸ’»

0
34

Comments 0

No comments yet. Be the first!