Skip to content
This repository was archived by the owner on May 7, 2020. It is now read-only.

Commit d97f515

Browse files
committed
reverted
1 parent 71f0820 commit d97f515

File tree

3 files changed

+7
-42
lines changed

3 files changed

+7
-42
lines changed

.gitignore

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
.env
2-
private
1+
*.psd

docs/index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
## Corona2
1+
2+
3+
<img src="img/Desktop.jpg" width="750" />
4+
5+
* [Design Challenge](https://www.topcoder.com/challenge-details/30055851/?type=design&noncache=true)

readme.md

+1-39
Original file line numberDiff line numberDiff line change
@@ -1,39 +1 @@
1-
2-
## tcProjWrapper
3-
4-
Often one or more github repos and google docs repositories are used in a single github project. For example: Front end and back end. In addition multiple public or private share for binary documents are also used. This project will serves as a wrapper for both of those conepts as well as being a single repository for documentation.
5-
6-
This project uses mkdocs to provide an simple platform to generate html pages from markdown. It can be hosted anywhere, includes special provisions for ghpages or can be run locally with ```mkdocs serve```
7-
8-
### Topcoder Theme
9-
This repository uses a third party theme called [cinder](https://github.com/chrissimpkins/cinder). However this theme has been forked and added the topcoder logo <img src="https://storage.googleapis.com/instapage-user-media/97c829ee/1997047-0-high-topcoder-horizo.png" height="22px"/>. It would be easy enough to include this forked code directly in the tcProjWrapper repo directly, except this project relies heavily on submodule for src so we wanted to include the theme as a submodule too. In addition the submodule could be forked or branched specifly to include a customers logo.
10-
11-
### Topcoder Docs
12-
Since this project also contains content, We can include standard docs like bug bash instructions.
13-
14-
# Quick Start
15-
1. Make sure you have python2 and pip2 installed, then run ```pip2 install mkdocs``` to install mkdocs
16-
2. clone the template ``` git clone --recursive [email protected]:topcoderinc/tcProjWrapper.git myproject ```
17-
3. cd ```myproject``` and run ```mkdocs serve```
18-
4. You should also edit the mkdocs.yml and edit the sitename. It might be a good idea to remove the .git dir and do a ```git init``` to orphan this template(repo) from your new wrapper project.
19-
20-
21-
## Changelog
22-
23-
* 2/13/2017 - ktb updated cinder submodule
24-
* 2/15/2017 - ktb added setup script in src dir
25-
26-
## example setup.sh
27-
```
28-
git clone --recursive [email protected]:topcoderinc/tcProjWrapper.git drone-series
29-
sed -i.bak s/tcprojWrapper/drone-series/g mkdocs.yml && rm mkdocs.yml.bak
30-
rm -rf .git*
31-
git init
32-
git add .
33-
git commit -am 'first commit, templated from [email protected]:topcoderinc/tcProjWrapper.git '
34-
mkdir src
35-
git submodule add [email protected]:topcoderinc/dsp-server.git src/dsp-server
36-
git submodule add [email protected]:topcoderinc/dsp-server.git src/dsp-frontend
37-
38-
39-
```
1+
Corona2 see docs pages

0 commit comments

Comments
 (0)