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.

Sign up for GitHub

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

Grammatically updated the Tech Docs #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Grammatically updated the Tech Docs #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9f70ab
Update README.md with project information and contribution guidelines
VectorGits Mar 25, 2024
23ba600
Fixed typo in nav tree
VectorGits Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# W3C validator for Holberton School
For HTML, CSS and SVG files
> This program is designed to validate `.HTML`, `.CSS`, and `.SVG` files. It checks these files for compliance with [W3C](https://www.w3.org/) standards, helping to ensure that your web content is accessible, reliable, and follows established web standards. This is crucial for maintaining compatibility across various web browsers and platforms. By using this program, developers can catch and fix errors early in the development process, improving the quality of their code and potentially saving time and resources.

Based on 1 API:
## Table of Contents
- [Requirements](#requirements)
- [Quickstart](#quickstart)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)

---

#### Based on 1 API:
- [Markup Validator Web Service API](https://validator.w3.org/docs/api.html)

## Requirements
Expand Down Expand Up @@ -52,3 +60,14 @@ python3 -m pip install requests
```

If you don't have `pip` installed, you can get it [here](https://pypi.org/project/pip/).

## Contributing

To contribute to this project, follow these steps:
* Fork this repository.
* Create a branch: `git checkout -b <branch_name>`.
* Make your changes and commit them: `git commit -m '<commit_message>'`.
* Push to the original branch: `git push`
* Create the pull request.

Alternatively see the Github documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).