Skip to content

brettjrea/GitHub_Generate_Readme

Repository files navigation

Title: "Node.js and Build Tools Installation Guide with Optional OS Upgrades"

1. Get Debian/Ubuntu:
  1. Install WSL Debian on Windows

  2. Install WSL Ubuntu on Windows

  3. Install VSCode with Remote Pack on Windows

2. Optional OS upgrades:
  1. Upgrade Debian Bullseye to Buster

  2. Upgrade Ubuntu Focal to Jammy

  3. Install Nix package Manager

3. Node.js tools:
  1. Install NVM - Node Version Manager

  2. Install NVS - Node Version Switcher (added 02/23 it is a cross-platform node based successor/replacement for NVM)

4. Build tools:
  1. Install common build tools.
5. Add a Backend:
  1. Install Strapi.io backend
6. Add a Frontend:
  1. Install Gatsby frontend
7. Configure Process Manager:
  1. Configure PM2 Process Manager
8. Add GitHub CLI:
  1. Install GitHub CLI

Github Generate Readme

This is a central repository for the readme and scripts across my GitHub, acting as a single source of truth. It uses GitHub actions and workflows to detect the modified files and direct the correct repository to run an action to update its readme and scripts from this repository.


A Good Readme.md

A README file is a document that contains information about the repository, such as what it is, how to use it, and other relevant details. Having a well-written README can help users understand and navigate your repository, making it more accessible and user-friendly.

A good README file should contain the following information:

  1. Project Overview: Provide a brief introduction to your project, what it does, and what problem it solves.

  2. Installation: Explain how to install your project, including any dependencies required.

  3. Usage: Provide instructions on how to use your project, including any commands or scripts required.

  4. Contributing: Explain how other users can contribute to your project, including how to submit issues or pull requests.

  5. License: Include a license for your project, specifying how others can use and distribute your code. test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published