Skip to content

Commit 4fd92b5

Browse files
committed
Merge remote-tracking branch 'origin/master' into issue-575_write-group
2 parents 23c50d5 + 3cc639c commit 4fd92b5

File tree

9 files changed

+49
-2
lines changed

9 files changed

+49
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ private static void onNotification(object sender, NotificationEventArgs e)
4747
}
4848
```
4949

50-
For more examples [check](https://github.com/DomCR/ACadSharp/tree/master/src/ACadSharp.Examples).
50+
For more code examples [check](https://github.com/DomCR/ACadSharp/tree/master/src/ACadSharp.Examples).
5151

52-
For more information visit the :construction: [wiki](https://github.com/DomCR/ACadSharp/wiki) :construction: .
52+
Visit the :construction: [wiki](https://github.com/DomCR/ACadSharp/wiki) :construction: for the API specification of the library.
53+
54+
Check the [documentation](https://github.com/DomCR/ACadSharp/tree/master/docs/) for specific information about some use cases.
5355

5456
Building
5557
---

docs/CadDocumentDocs.md

Whitespace-only changes.

docs/CadObjectDocs.md

Whitespace-only changes.

docs/CadReaderDocs.md

Whitespace-only changes.

docs/CadWriterDocs.md

Whitespace-only changes.

docs/EntityDocs.md

Whitespace-only changes.

docs/NonGraphicalObjectDocs.md

Whitespace-only changes.

docs/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ACadSharp
2+
3+
ACadSharp is a pure C# library to read/write cad files like dxf/dwg.
4+
5+
## Quick Start
6+
7+
### Read
8+
9+
If you want to read a cad file you just need to pick the reader that matches the format, for dwg files you can use [`ACadSharp.IO.DwgReader`](https://github.com/DomCR/ACadSharp/wiki/ACadSharp.IO.DwgReader) or [`ACadSharp.IO.DxfReader`](https://github.com/DomCR/ACadSharp/wiki/ACadSharp.IO.DxfReader) for a dxf file.
10+
11+
The following example shows how to use the `DwgReader` using the static `Read()` method, the `DxfReader` has the equivalent method as well.
12+
13+
```C#
14+
CadDocument doc = DwgReader.Read(file);
15+
```
16+
17+
Both readers have a parameter to configure the reader behaviour and a notification system to log information about possible issues that may occur during the read operation, for more information check [CadReader](./CadReaderDocs.md).
18+
19+
### Document operations
20+
21+
Once you have read the [``CadDocument``](https://github.com/DomCR/ACadSharp/wiki/ACadSharp.CadDocument) or created a new one, you can perform any operation that you may need:
22+
23+
- Check or modify the existing entities and extract any information like geometry, color, layer, lineType...
24+
- Create new entities in the model.
25+
- Create new table entries like Layers, LineTypes, Blocks...
26+
- Add, read or remove ``XData`` in any object in the document.
27+
28+
For more information about how the CadDocument is structured check [CadDocument](./CadDocumentDocs.md).
29+
30+
To understand the common properties of the different elements in the document check the documentation for the different types of objects:
31+
- [CadObject](./CadObjectDocs.md)
32+
- [Entity](./EntityDocs.md)
33+
- [NonGraphicalObject](./NonGraphicalObjectDocs.md)
34+
- [TableEntry](./TableEntryDocs.md)
35+
36+
### Write
37+
38+
Save your file using the [``DwgWriter``](https://github.com/DomCR/ACadSharp/wiki/ACadSharp.IO.DwgWriter) or [``DxfWriter``](https://github.com/DomCR/ACadSharp/wiki/ACadSharp.IO.DxfWriter) depending on the format that you want to use.
39+
40+
```C#
41+
string file = "your file path";
42+
DwgWriter.Write(file, doc);
43+
```
44+
45+
Similar as with the `CadReader` the `CadWriter` have a configuration and a notification system, for more information check [CadReader](./CadWriterDocs.md).

docs/TableEntryDocs.md

Whitespace-only changes.

0 commit comments

Comments
 (0)