Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
donwilson committed Jul 25, 2023
1 parent dfc610c commit 43dfaf4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,21 @@ Magnetar is a robust PHP framework for creating highly scalable, blazing fast we

### Getting Started

#### Docker

1. Clone the repository `git clone https://github.com/pyxol/pulsar.git`
2. Using CLI navigate into the newly created `pulsar` directory
3. Run `docker-compose up -d`
4. View the website at [http://localhost/](http://localhost/)

#### Manual

1. Clone the repository `git clone https://github.com/pyxol/pulsar.git`
2. Using CLI navigate into the newly created `pulsar` directory
3. Install [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) if needed
4. Install the framework using either `composer install` or `php composer.phar install` depending on your environment.
5. Point your web server to the `public` directory
6. View the website using your web server's URL

### Issues
If you run into any issues, please [open an issue](https://github.com/pyxol/pulsar/issues).
2 changes: 2 additions & 0 deletions themes/pulsar_theme/frontpage.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@

<p>Welcome to a fully featured Web Application framework powered by <a href="https://www.github.com/pyxol/magnetar/" target="_blank">Magnetar</a>.</p>

<p><a href="https://github.com/pyxol/pulsar" target="_blank" title="PHP Web Application Framework" class="btn btn-primary"><strong>Try Pulsar</strong></a></p>

<?php
display_tpl('footer');

0 comments on commit 43dfaf4

Please sign in to comment.