Skip to content

Commit 5fa3689

Browse files
committed
Updated the README to exclude project-specific files and VS2015 files. Also added instructions for new developers to follow.
1 parent 5c2b5ad commit 5fa3689

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#################
2+
## YAFNET
3+
#################
4+
5+
# ignore the required YAFNET source directory
6+
yafsrc/
7+
yaf_dnn/packages/
8+
19
#################
210
## Eclipse
311
#################
@@ -36,6 +44,9 @@ local.properties
3644
## Ignore Visual Studio temporary files, build results, and
3745
## files generated by popular Visual Studio add-ons.
3846

47+
# 2015
48+
.vs/
49+
3950
# User-specific files
4051
*.suo
4152
*.user

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,19 @@ There is also a Second Child Module the *YAF.NET Forums What's New* Module which
2929

3030
A "sandbox" test forum is available here: http://testforum.yetanotherforum.net/.
3131

32+
### Getting Started with Development
33+
34+
This project is dependent upon the parent solution, YAFNET. This requires that the steps you follow be specific.
35+
36+
1. Create a local directory for your project o live, such as C:\dev\YAFDev\ (just an example path).
37+
2. Fork this YAFNET-DNN project into your account and then clone it into the local folder you just created. There should now be a C:\dev\YAFDev\yaf_dnn\ folder, as well as a README and other Git files.
38+
3. (Optional) Attach an upstream to this YAFNET-DNN project in Git.
39+
4. Download a copy of the Master branch of [the YAFNET project](https://github.com/YAFNET/YAFNET), and extract to the main folder. The resulting path should be C:\dev\YAFDev\yafsrc\.
40+
5. Open and then build the YAFNET solution.
41+
6. Open and then build the YAFNET-DNN solution.
42+
43+
Congratulations! You're now ready to begin development.
44+
3245
### Support
3346

3447
* Free Community based Support Forum here: http://forum.yetanotherforum.net/.

0 commit comments

Comments
 (0)