search

PaintLab / PixelFarm

From Vectors to (sub) Pixels, C# 2D Rendering Library
Other
156 stars 20 forks source link

Getting Started for Newcomers? #22

Open Aneutronic opened 6 years ago

Aneutronic commented 6 years ago

Hi. I am extremely interested in your work here, and am extremely grateful for the dedication to permissive licenses only. However, I am having trouble getting started with your code. How would I use your library in the development of a new application? How would I dig through it, to learn about it and understand it? How is it organized? How would I add to it? Please don't take offense, but there is very little documentation that I can find on how to get started with your code.

I am very interested in using your work in a project of mine, but I am at a loss of where to start.

Thank you for all of your time and effort, and happy coding!

prepare commented 6 years ago

@Aneutronic ,

Sorry for late reply. Thank you for your interest.

I will develop a documentation soon, after I finish the 'smaa....' branch.

(that branch will change some important aspects in the code)

at this point please start with the 'Test...' projects

Happypig375 commented 5 years ago

Imo I don't even know what to reference. Which is the main project? Which does what? Some imported code lives inside src/PixelFarm/Backend while others live in external? I guess there is no other way to figure out except downloading the whole repository.