Skip to content

Commit 461fcf7

Browse files
authored
docs(readme): Update quick start and create link to contributing.md (#149)
1 parent 4193938 commit 461fcf7

File tree

1 file changed

+5
-55
lines changed

1 file changed

+5
-55
lines changed

README.md

Lines changed: 5 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- markdownlint-disable MD033 MD041-->
1+
<!-- markdownlint-disable MD033 MD041 -->
22
<p align="center">
33
<h3 align="center">⌨️ Readme Typing SVG</h3>
44
</p>
@@ -19,12 +19,14 @@
1919

2020
1. Copy-paste the markdown below into your GitHub profile README
2121
2. Replace the value after `?lines=` with your text. Separate lines of text with semicolons and use `+` or `%20` for spaces.
22-
3. (Optional) Adjust the width parameter (see below) to fit the full width of your text.
22+
3. Adjust the width parameter (see below) to fit the full width of your text.
2323

2424
```md
2525
[![Typing SVG](https://readme-typing-svg.demolab.com/?lines=First+line+of+text;Second+line+of+text)](https://git.io/typing-svg)
2626
```
2727

28+
4. Star the repo 😄
29+
2830
## ⚙ Demo site
2931

3032
Here you can easily customize your Typing SVG with a live preview.
@@ -116,57 +118,7 @@ Contributions are welcome! Feel free to open an issue or submit a pull request i
116118

117119
Make sure your request is meaningful and you have tested the app locally before submitting a pull request.
118120

119-
### Installing requirements
120-
121-
#### Requirements
122-
123-
- [PHP 7](https://www.apachefriends.org/index.html)
124-
- [Composer](https://getcomposer.org)
125-
126-
#### Linux
127-
128-
```bash
129-
sudo apt-get install php
130-
sudo apt-get install php-curl
131-
sudo apt-get install composer
132-
```
133-
134-
#### Windows
135-
136-
Install PHP from [XAMPP](https://www.apachefriends.org/index.html) or [php.net](https://windows.php.net/download)
137-
138-
[▶ How to install and run PHP using XAMPP (Windows)](https://www.youtube.com/watch?v=K-qXW9ymeYQ)
139-
140-
[📥 Download Composer](https://getcomposer.org/download/)
141-
142-
### Clone the repository
143-
144-
```bash
145-
git clone https://github.com/DenverCoder1/readme-typing-svg.git
146-
cd readme-typing-svg
147-
```
148-
149-
### Running the app locally
150-
151-
```bash
152-
composer start
153-
```
154-
155-
Open <http://localhost:8000/> and add parameters to run the project locally.
156-
157-
### Running the tests
158-
159-
Before you can run tests, PHPUnit must be installed. You can install it using Composer by running the following command.
160-
161-
```bash
162-
composer install
163-
```
164-
165-
Run the following command to run the PHPUnit test script which will verify that the tested functionality is still working.
166-
167-
```bash
168-
composer test
169-
```
121+
Refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for more details on contributing, installing requirements, and running the application.
170122

171123
## 🙋‍♂️ Support
172124

@@ -186,9 +138,7 @@ composer test
186138
Made with ❤️ and PHP
187139

188140
<!-- markdownlint-disable MD033 -->
189-
190141
<a href="https://heroku.com/"><img alt="Powered by Heroku" title="Powered by Heroku" src="https://img.shields.io/badge/-Powered%20by%20Heroku-6567a5?style=for-the-badge&logo=heroku&logoColor=white"/></a>
191-
192142
<!-- markdownlint-enable MD033 -->
193143

194144
This project uses [Twemoji](https://github.com/twitter/twemoji), published under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)

0 commit comments

Comments
 (0)