Skip to content

Commit ea1d948

Browse files
committed
add index.mdi
1 parent ff70387 commit ea1d948

23 files changed

+123
-8
lines changed

Introduction.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Signum Framework
2+
3+
Welcome to Signum Framework Documentation, the main source of information Framework.
4+
5+
6+
## Introduction to the documentation
7+
8+
Signum Framework helps you in all the stages of writing a business application:
9+
10+
* Modeling entities.
11+
* Access the database using the ORM and the LINQ provider.
12+
* Windows and Web user interfaces.
13+
* Tests...
14+
15+
We try to keep the API clean and consistent, and use technologies that could be familiar to a .Net developer, but still, it can take some time to feel comfortable building applications.
16+
17+
In order to get used to the API, **a good level of C# is necessary**. Also some familiarity with the UI underlying framework is recommended:
18+
* Signum.Windows: WPF and XAML
19+
* Signum.Web: ASP.NET MVC, Razor, Javascript, Typescript and Bootstrap.
20+
21+
### Reading the documentation
22+
23+
This documentation tries to be a good reference that covers most of the framework.
24+
25+
Is not auto-generated from source code comments, but redacted manually. This means that not every single public method will be explained, on the other side it does a better job introducing each class, giving rationale, comparing with alternatives and giving recommendations.
26+
27+
While the documentation comes from the Markdown files that are distributed with the source code, it's ordered in a way that is easier to follow.
28+
29+
In that sense the documentation can be used **as a reference guide**, but can also be read **as a book** to have a general understanding and discover new features.
30+
31+
## Alternatives
32+
33+
### Tutorials
34+
35+
If you prefer to learn by example, here are some tutorials in Complex (a little bit out-dated).
36+
37+
* **[Signum Framework Principles](http://www.codeproject.com/Articles/34560/Signum-Framework-Principles)**: Explains the reasons behind Signum Framework, the tecnologies we use, and the projects where Signum Framework fits. Also, we test our LINQ Provider against Frans Bouma's test.
38+
39+
* **[Signum Framework Tutorials Part 1 – Southwind Entities](http://www.codeproject.com/Articles/224841/Signum-Framework-Tutorials-Part-Southwind-Entiti)**: This is the first tutorial of the Southwind serie. The idea is to create a whole solution using Signum Framework that mimics Microsoft Northwind example database. In this tutorial we explain how to write entities and validators
40+
41+
* **[Signum Framework Tutorials Part 2 – Southwind Logic](http://www.codeproject.com/Articles/230360/Signum-Framework-Tutorials-Part-Southwind-Logic)**: In this part, we will focus on writing business logic, LINQ queries and explain inheritance
42+
43+
* **[Signum Framework Tutorials Part 3 – Southwind Load](http://www.codeproject.com/Articles/493158/Signum-Framework-Tutorials-Part-3-SouthWind-Load)**: In this tutorial we will focus on moving the data from Northwind Database to the new Southwind
44+
45+
### Videos
46+
47+
Or if you prefer to watch some YouTube videos to do real work:
48+
49+
* **[Signum Philosophy and Vision](https://www.youtube.com/watch?v=bJNbv5kHC0s): Cartoon animation explaining the philosophy behind Signum Framework.** The historical context (ORMs and Linq) and what Signum Framework offers to the development of data-centric applications. Finally, a very concrete example shows how Signum Framework simplifies the development and maintenance of an hypothetical application.
50+
51+
* **[Video Tutorial 0 - Basics](https://www.youtube.com/watch?v=6aVDRbVJwX4): Basic tutorial to get comfortable with the ORM.** We use a Console Application to model a simple entity class, create the database and save and retrieve some entity objects.
52+
53+
* **[Video Tutorial 1 - Writing the Entities](https://www.youtube.com/watch?v=fqaquajRf38): First tutorial to develop a real application for a Shop.** We explain the typical architecture of a client-server system, and how to model the entities (adding db constraints and validations) the first and more important step when building an application using Signum Framework.
54+
55+
* **[Video Tutorial 2 - Writing the Server Code](https://www.youtube.com/watch?v=Rr21NTMQwTk): Second tutorial to develop a real application for a Shop.** We learn how to create the database, load legacy data, write the business logic, and set-up the web server that will be used by the client applications.
56+
57+
* **[Video Tutorial 3 - Writing the Client Code](http://signumframework.com/VideoTutorialClient.ashx): Third and last tutorial to develop a real application for a Shop.** We learn how to create the UserControls for our entities, customize them, and write LINQ queries on the server for the SearchControl.
58+
59+
60+
### Courses
61+
62+
**[Training courses](http://www.signumsoftware.com/en/Training)**: Designed for teams of developers that need to start fast and want some Skype session, or Face-to-face course during a period of about week.

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
11
[Signum Framework](http://www.signumframework.com/)
22
===================================================
33

4-
Signum Framework is the new Open Source framework from Signum Software for writing data-centric applications over the latest Microsoft technologies: .Net 4.0, C# 5.0, WPF, ASP.Net MVC 3.0 (Razor) and Typescript.
4+
Signum Framework is an Open Source framework from Signum Software for writing data-centric applications over the latest technologies from Microsoft (.Net 4.5.1, C# 5.0, WPF, ASP.Net MVC 3.0, Razor and Typescript) and web standard libraries (jQuery, Bootstrap and D3) .
55

6-
The main focus of the framework is being able to write vertical modules (database tables, entities, logic and Win / Web user interface) that can be shared between projects
6+
The main focus of the framework is being able to write vertical modules (database tables, entities, logic and Win / Web user interface) that can be shared between projects.
77

8-
It provides a consistent model for N-layer architectures by moving the entities to the very centre of your solution using Signum.Entities.
8+
It provides a consistent model for N-layer architectures by moving the entities to the very center of your solution using Signum.Entities.
99

10-
Our cutting-edge ORM, Signum.Engine, has one of the first full LINQ Providers implemented outside Microsoft offices.
10+
Our cutting-edge ORM, Signum.Engine, has a full LINQ Providers that avoids N + 1 problem and lets you UPDATE / DELETE / INSERT entities without having to retrieve them first..
1111

12-
Signum.Windows dramatically simplifies giving a WPF user interface to your entities.
12+
Signum.Windows dramatically simplifies writing a WPF user interface for your entities.
1313

1414
Also Signum.Web does the same using ASP.Net MVC 3.0 / Razor / jQuery / Bootstrap and TypeScript
1515

1616
### Main Features ###
17-
* Designed for vertical modules (Bounded Context in DDD jargon)
17+
* Designed for vertical modules (aka: Bounded Context)
1818
* Entities-first approach
1919
* ORM with a full LINQ Provider
2020
* Unified validation
21-
* Schema generation (and sync)
21+
* Schema generation and synchronization
2222
* WPF smart-client interface
2323
* ASP.Net MVC 4.0 Razor
2424

2525

2626
### Principles ###
2727
* Promote simple and clean code, avoiding astronautical architectures
28-
* Favour compile-time checked C# over error-prone XML configurations
28+
* Favor compile-time checked C# over error-prone XML configurations
2929
* Create a solid foundation for the integration of application modules (on schema, BL and UI code)
3030
* Encourage a more functional way of programming
3131
* Avoid code duplication at any cost
3232
* Be a good citizen wherever we are (.Net, LINQ, WPF, ASP.Net MVC) following common practices and conventions
3333

34+
## Getting Started
35+
36+
* **[Signum Framework](http://www.signumsoftware.com/en/Framework)**: Know what makes Signum Framework suited for building complex business applications.
37+
* **[Signum Extensions](http://www.signumsoftware.com/en/Framework)**: A set of ready-to-use modules that work with any Signum Framework application.
38+
* **[Documentation](http://www.signumsoftware.com/en/Documentation)**: Tutorials (in CodeProject) and Documentation (from Markdown files in GitHub)
39+
* **[Create Application](http://www.signumsoftware.com/en/Documentation)**: The simplest way to get started. Create a new project by renaming and customizing Southwind example application.
File renamed without changes.
File renamed without changes.

Signum.Engine/Linq/index.mdi

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Linq.Entity
2+
Linq.Lite
3+
Linq.Inheritance
4+
Linq.SelectMany
5+
Linq.Join
6+
Linq.ElementOperators
7+
Linq.SqlFunction
8+
Linq.TypeMismatch
9+
Linq.Appendix

Signum.Engine/index.mdi

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Introduction
2+
Database
3+
Database.Save
4+
Database.Retrieve
5+
Database.Query
6+
Linq
7+
Database.Delete
8+
Database.UnsafeDelete
9+
Database.UnsafeUpdate
10+
Database.UnsafeInsert
11+
Schema
12+
Connection
13+
EntityCache
14+
Administrator
File renamed without changes.
File renamed without changes.

Signum.Entities/index.mdi

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Introduction
2+
BaseEntities
3+
MList
4+
Lite
5+
Inheritance
6+
ChangeTracking
7+
Validation
8+
EnumEntity
9+
Symbol
10+
MixinEntity
11+
FieldAttributes
12+
PropertyAttributes
13+
EntityKindAttribute
14+
Services

Signum.Utilities/Extensions/index.mdi

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Introduction
File renamed without changes.

Signum.Utilities/index.mdi

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Introduction
2+
Extensions

index.mdi

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Introduction
2+
Readme
3+
Signum.Entities
4+
Signum.Engine
5+
Signum.Windows
6+
Signum.Web
7+
Signum.Utilities

0 commit comments

Comments
 (0)