mirror of
https://git.teknik.io/Teknikode/Teknik.git
synced 2023-08-02 14:16:22 +02:00
Minor fixes
Fixed minor grammar corrections, removed bolds and code block highlights, marked files and dirs with backticks
This commit is contained in:
parent
6160ac1f59
commit
3c324ddf0d
28
README.md
28
README.md
@ -5,7 +5,7 @@ Teknik is a suite of services with attractive and functional interfaces.
|
|||||||
## Features
|
## Features
|
||||||
* File Upload w/ encryption
|
* File Upload w/ encryption
|
||||||
* Pastebin
|
* Pastebin
|
||||||
* Url Shortening
|
* URL Shortening
|
||||||
* Blogs
|
* Blogs
|
||||||
* Git Repositories
|
* Git Repositories
|
||||||
* Podcasts
|
* Podcasts
|
||||||
@ -17,27 +17,27 @@ You can see a live demo [here](https://www.teknik.io).
|
|||||||
## Requirements
|
## Requirements
|
||||||
In order to run Teknik on your server, you'll need:
|
In order to run Teknik on your server, you'll need:
|
||||||
|
|
||||||
* IIS 7+ with URL Rewrite module or Apache with mod_rewrite enabled (Requires conversion of web.config files)
|
* IIS 7+ with URL Rewrite module or Apache with `mod_rewrite` enabled (Requires conversion of `web.config` files)
|
||||||
* ASP.NET MVC 5
|
* ASP.NET MVC 5
|
||||||
* .NET Framework 4.5.2
|
* .NET Framework 4.5.2
|
||||||
* MS SQL Server
|
* MS SQL Server
|
||||||
* hMailServer (If running email as well)
|
* hMailServer (If running email as well)
|
||||||
* Web Mail Client (If you would like to have webmail)
|
* Web Mail Client (If you would like to have webmail)
|
||||||
* Gogs Service (If you want to have git integration)
|
* Gogs Service (If you want to have Git integration)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
* Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from.
|
* Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from
|
||||||
|
|
||||||
```
|
```nohighlight
|
||||||
cd /var/www
|
cd /var/www
|
||||||
git clone https://git.teknik.io/Teknikode/Teknik
|
git clone https://git.teknik.io/Teknikode/Teknik
|
||||||
```
|
```
|
||||||
|
|
||||||
* Open the Teknik.sln file to build the project.
|
* Open the `Teknik.sln` file to build the project
|
||||||
* Copy the build files to your wwwroot directory.
|
* Copy the build files to your `wwwroot` directory
|
||||||
* Create a **ConnectionStrings.config** file in the **App_Data** directory and fill it with the following template and put in your sql server conenction details
|
* Create a `ConnectionStrings.config` file in the `App_Data` directory and fill it with the following template and put in your SQL server conenction details
|
||||||
|
|
||||||
```
|
```nohighlight
|
||||||
<connectionStrings>
|
<connectionStrings>
|
||||||
<add name="TeknikEntities"
|
<add name="TeknikEntities"
|
||||||
providerName="System.Data.SqlClient"
|
providerName="System.Data.SqlClient"
|
||||||
@ -45,22 +45,22 @@ git clone https://git.teknik.io/Teknikode/Teknik
|
|||||||
</connectionStrings>
|
</connectionStrings>
|
||||||
```
|
```
|
||||||
|
|
||||||
* After first run, a **Config.json** file will be created in the **App_Data** directory. This will need to be edited with your configuration options.
|
* After the first run, a `Config.json` file will be created in the `App_Data` directory. This will need to be edited with your configuration options.
|
||||||
|
|
||||||
**That's it**, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
|
That's it, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
|
||||||
|
|
||||||
## Authors and contributors
|
## Authors and contributors
|
||||||
* [Chris Woodward](https://www.teknik.io) (Creator, developer)
|
* [Chris Woodward](https://www.teknik.io) (Creator, Developer)
|
||||||
* [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)
|
* [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
[BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)
|
[BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
You can view Teknik's [Development Branch](https://dev.teknik.io/) to see the current new features. (It may not work, as it is a development branch)
|
You can view Teknik's [Development Branch](https://dev.teknik.io/) to see the current new features (It may not work, as it is a development branch).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
If you are a developer, we need your help. Teknik is a young project and we have lot's of stuff to do. Some developers are contributing with new features, others with bug fixes. Any help you can give would be greatly appreciated!
|
If you are a developer, we need your help. Teknik is a young project and we have lots of stuff to do. Some developers are contributing with new features, others with bug fixes. Any help you can give would be greatly appreciated!
|
||||||
|
|
||||||
## Further information
|
## Further information
|
||||||
If you want to know more about the features of Teknik, check the [Help](https://help.teknik.io/) page. Also, if you're having problems with Teknik, let us know through the [Contact](https://contact.teknik.io/) page. Don't forget to give feedback and suggest new features! :)
|
If you want to know more about the features of Teknik, check the [Help](https://help.teknik.io/) page. Also, if you're having problems with Teknik, let us know through the [Contact](https://contact.teknik.io/) page. Don't forget to give feedback and suggest new features! :)
|
||||||
|
Loading…
Reference in New Issue
Block a user