fix based on https://gist.github.com/timbrom/1942280
[DSO138] / readme.txt
1 =================================\r
2 DSO138 Source Codes\r
3 Ver: 113-13801-037\r
4 \r
5 (C) JYE Tech Ltd. All right reserved\r
6 \r
7 Web:     www.jyetech.com\r
8 Forum:   www.jyetech.com/forum\r
9 Email:   jyetek@gmail.com\r
10 =================================\r
11 \r
12 1. Contents\r
13 -----------\r
14 Files contained in this package include:\r
15 \r
16  1 ) 113-13801.c     -- The main program\r
17  2 ) Board.c         -- Functions for initialization and lower level operation\r
18  3 ) Board.h         -- Header file\r
19  4 ) Command.c       -- Functions for key command analysis and execution\r
20  5 ) Command.h       -- Header file\r
21  6 ) Common.c        -- Basic type definitions and general functions\r
22  7 ) Common.h        -- Header file\r
23  8 ) Eeprom.c        -- Emulation of EEPROM \r
24  9 ) Eeprom.h        -- Header file\r
25 10 ) stm32f103_it.c  -- Interrupt handlers\r
26 11 ) stm32f103_it.h  -- Header file\r
27 12 ) Screen.c        -- Functions for screen related operations\r
28 13 ) Screen.h        -- Header file \r
29 14 ) libdso138.a     -- Library of DSO138 core\r
30 15 ) libdso138.h     -- Header file\r
31 16 ) stm32f10x_conf.h -- Configuration file\r
32 17 ) startup_stm32f10x_md.S -- Start-up file \r
33 18 ) makefile        -- Makefile for building the project\r
34 19 ) STM32F10x_64k_20k_flash.ld -- Linker script\r
35 20 ) readme.txt      -- This file.\r
36 21 ) Libraries(folder) -- Libraries for STM32F10x MCUs\r
37 \r
38 2. How To Build\r
39 ---------------\r
40 The project was developped under CodeSourcery G++ Lite. Under Windows environment please follow the steps below to build the project:\r
41 \r
42 1 ) Download Code Sourcery G++ Lite from http://www.mentor.com/. Install it and have environment variables setup properly as instructed in the accompanied documents.\r
43 2 ) Unzip all files in this package to a folder.\r
44 3 ) Open a command line window under Windows. Switch to the folder that contains the unzipped files with "CD" command. Type and execute "cs-make" from the folder.\r
45 \r
46 \r
47 3. Support\r
48 ----------\r
49 There is no technical support for questions related to the source codes. However, users are welcome to present their questions to and seek helps in JYE Tech Forum (http://www.jyetech.com/forum).\r
50 \r
51 \r
52 4. License\r
53 ----------\r
54 DSO138 source codes are free software and open for education, research, and commercial\r
55 developments under license policy of the following terms.\r
56 \r
57 Copyright (C)2014 JYE Tech Ltd., All right reserved\r
58 \r
59 1 ) DSO138 source codes are free software and there is NO WARRANTY.\r
60 2 ) You can use, modify, and redistribute it for personal, non-profit, or commercial product UNDER YOUR OWN RESPONSIBILITY.\r
61 3 ) Redistributions of source codes must retain the above copyright notice.\r
62 \r
63 \r
64 \r
65 5. Revision History\r
66 -------------------\r
67 \r
68 Version    Date         Summary\r
69 --------------------------------\r
70 0.37       2015.03.05   Fixed a bug that sometimes causes hang when timebase is changed from 20ms to 50ms\r
71 0.36       2014.12.25   Minor change to the library file\r
72 0.35       2014.12.20   First release.\r
73 \r