Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Readme changes to make it Astro Theme Guide #23

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

axyut
Copy link
Contributor

@axyut axyut commented Oct 29, 2024

Context

The needs of issue #5 is solved with this request.

Changes

  • only the README.md file is changed, I also request to change the repo to a template repo.
  • Different contents are taken from other different astro themes but is ncitalums unique.
  • If the project goals, wanted features were more clear more contents could be created/added.

README.md Outdated
Start by installing the project dependencies. Open your terminal, navigate to the project's root directory, and execute:

```bash
npm install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@axyut I saw you get mixed up with yarn and NPM while we have used yarn for this project. Please consider updating these to yarn instead of NPM.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

README.md Outdated
@@ -1,6 +1,164 @@
# NCIT Alumni Portal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead lets go for Open Alumn Portal as project name. As we are looking forward to change repo name too once we get basic things done.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

@SatyaRajAwasth1
Copy link
Contributor

@axyut Please go through the comments and make the changes, then we can move forward with merging this PR.

@SatyaRajAwasth1 SatyaRajAwasth1 merged commit bf92b00 into noskofficial:main Oct 29, 2024
@SatyaRajAwasth1 SatyaRajAwasth1 added the hacktoberfest-accepted Hacktoberfest Valid Merge label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Hacktoberfest Valid Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants